package com.groupname.dangerousdelves;

// -------------------------------------------------------------------------
/**
 * The base class for all Shield objects.
 *
 * @author sluke1
 * @version Dec 7, 2012
 */
public class Shield
{
    private int     defense;
    private boolean equipped;
    private String  description;


    // ----------------------------------------------------------
    /**
     * Create a new Shield object.
     */
    public Shield()
    {
        defense = 0;
        equipped = false;
        description = "";
    }


    // ----------------------------------------------------------
    /**
     * Sets the defense.
     *
     * @param inDefense
     *            the new defense.
     */
    public void setDefense(int inDefense)
    {
        defense = inDefense;
    }


    // ----------------------------------------------------------
    /**
     * Returns the defense.
     *
     * @return the defense.
     */
    public int getDefense()
    {
        return defense;
    }


    // ----------------------------------------------------------
    /**
     * Sets the status of equipped.
     *
     * @param inEquipped
     *            the new value of equipped.
     */
    public void setEquipped(boolean inEquipped)
    {
        equipped = inEquipped;
    }


    // ----------------------------------------------------------
    /**
     * Returns equipped.
     *
     * @return the equipped status.
     */
    public boolean getEquipped()
    {
        return equipped;
    }


    // ----------------------------------------------------------
    /**
     * Place a description of your method here.
     *
     * @return the description
     */
    public String getDescription()
    {
        return description;
    }


    // ----------------------------------------------------------
    /**
     * Sets the description.
     *
     * @param inDescrip
     *            the new description.
     */
    public void setDescription(String inDescrip)
    {
        description = inDescrip;
    }

}
